Vcenter Namespaces Networks Nsx SharedSubnets FilterSpec

Vcenter Namespaces Networks Nsx SharedSubnets FilterSpec

The Vcenter Namespaces Networks Nsx SharedSubnets FilterSpec schema contains properties used to filter the results when listing Subnets (see GET /vcenter/namespaces/networks/nsx/shared-subnets).

This schema was added in vSphere API 9.1.1.0.

JSON Example

{
    "project": "string",
    "vpc": "string",
    "namespace_project": "string",
    "namespace_vpc": "string",
    "supervisor": "string",
    "compatible": false
}

string

project

Required  

Identifier of NSX Project for a vSphere Namespace. This parameter is used to list subnets.

This property was added in vSphere API 9.1.1.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: NSXProject. When operations return a value of this schema as a response, the property will be an identifier for the resource type: NSXProject.

string

vpc

Required  

Identifier of VPC for a vSphere Namespace. This parameter is used to list subnets.

This property was added in vSphere API 9.1.1.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.networks.nsx.Vpc. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.networks.nsx.Vpc.

string

namespace_project

Optional

Identifier of the NSX Project for a vSphere Namespace. This parameter is used to check shared subnet compatibility.

This property was added in vSphere API 9.1.1.0.

If missing or null, the system will not check if the listed subnet is shared with Vcenter Namespaces Networks Nsx SharedSubnets FilterSpec.namespace_project

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: NSXProject. When operations return a value of this schema as a response, the property will be an identifier for the resource type: NSXProject.

string

namespace_vpc

Optional

Identifier of VPC for a vSphere Namespace. This parameter is used to check shared subnet compatibility.

This property was added in vSphere API 9.1.1.0.

If missing or null, the system will not check if the listed subnet is shared with Vcenter Namespaces Networks Nsx SharedSubnets FilterSpec.namespace_project

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.networks.nsx.Vpc. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.networks.nsx.Vpc.

string

supervisor

Optional

Identifier for the Supervisor.

This property was added in vSphere API 9.1.1.0.

If missing or null, Vcenter Namespaces Networks Nsx SharedSubnets FilterSpec.zones needs to be set.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

boolean

compatible

Optional

Compatibility criteria. If true, either Vcenter Namespaces Networks Nsx SharedSubnets FilterSpec.zones or Vcenter Namespaces Networks Nsx SharedSubnets FilterSpec.supervisor need to be set. Only Subnets which are compatible with that vSphere Namespace will be returned. If false only incompatible Subnets matching the other specified criteria will be returned.

This property was added in vSphere API 9.1.1.0.

If missing or null, both compatible and incompatible Subnets will be returned.